home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 1.iso / dist / fw_apache2.idb / usr / freeware / apache2 / include / util_time.h.z / util_time.h
C/C++ Source or Header  |  2002-07-08  |  5KB  |  124 lines
  1. /* ====================================================================
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2001-2002 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Apache" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation.  For more
  51.  * information on the Apache Software Foundation, please see
  52.  * <http://www.apache.org/>.
  53.  *
  54.  */
  55.  
  56. #ifndef APACHE_UTIL_TIME_H
  57. #define APACHE_UTIL_TIME_H
  58.  
  59. #include "apr.h"
  60. #include "apr_time.h"
  61. #include "httpd.h"
  62.  
  63. #ifdef __cplusplus
  64. extern "C" {
  65. #endif
  66.  
  67. /**
  68.  * @package Apache date/time handling functions
  69.  */
  70.  
  71. /* Maximum delta from the current time, in seconds, for a past time
  72.  * to qualify as "recent" for use in the ap_explode_recent_*() functions:
  73.  */
  74. #define AP_TIME_RECENT_THRESHOLD 15
  75.  
  76. /**
  77.  * convert a recent time to its human readable components in local timezone
  78.  * @param tm the exploded time
  79.  * @param t the time to explode: MUST be within the last
  80.  *          AP_TIME_RECENT_THRESHOLD seconds
  81.  * @note This is a faster alternative to apr_explode_localtime that uses
  82.  *       a cache of pre-exploded time structures.  It is useful for things
  83.  *       that need to explode the current time multiple times per second,
  84.  *       like loggers.
  85.  * @return APR_SUCCESS iff successful
  86.  */
  87. AP_DECLARE(apr_status_t) ap_explode_recent_localtime(apr_time_exp_t *tm,
  88.                                                      apr_time_t t);
  89.  
  90. /**
  91.  * convert a recent time to its human readable components in GMT timezone
  92.  * @param tm the exploded time
  93.  * @param t the time to explode: MUST be within the last
  94.  *          AP_TIME_RECENT_THRESHOLD seconds
  95.  * @note This is a faster alternative to apr_time_exp_gmt that uses
  96.  *       a cache of pre-exploded time structures.  It is useful for things
  97.  *       that need to explode the current time multiple times per second,
  98.  *       like loggers.
  99.  * @return APR_SUCCESS iff successful
  100.  */
  101. AP_DECLARE(apr_status_t) ap_explode_recent_gmt(apr_time_exp_t *tm,
  102.                                                apr_time_t t);
  103.  
  104.  
  105. /**
  106.  * format a recent timestamp in the ctime() format.
  107.  * @param date_str String to write to.
  108.  * @param t the time to convert 
  109.  */
  110. AP_DECLARE(apr_status_t) ap_recent_ctime(char *date_str, apr_time_t t);
  111.  
  112. /**
  113.  * format a recent timestamp in the RFC822 format
  114.  * @param date_str String to write to (must have length >= APR_RFC822_DATE_LEN)
  115.  * @param t the time to convert 
  116.  */
  117. AP_DECLARE(apr_status_t) ap_recent_rfc822_date(char *date_str, apr_time_t t);
  118.  
  119. #ifdef __cplusplus
  120. }
  121. #endif
  122.  
  123. #endif  /* !APACHE_UTIL_TIME_H */
  124.